GetName

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODDocument

GetName
The GetName method returns the name of this document.
ODDocumentName GetName ();
return value
The name of the document, or an empty sequence if the document does not have a name.

DISCUSSION
Although parts can call this method, they are not usually concerned with document names.
If this document has a name, this method returns a copy of that name. Otherwise, the text field of the result ODDocumentName structure represents an empty sequence of characters; that is, the text field is an ODByteArray structure whose _length field contains 0 and whose _buffer field contains a null pointer.

EXCEPTIONS

kODErrInvalidPersistentFormat
Unable to read the name from persistent storage because it is not in a recognized format.

SEE ALSO
The ODDocumentName type (page 902).
The ODDocument::SetName method (page 145).